---
title: 规则
description: 通过编辑器规则将 Ultracite 与 AI 编码助手集成的方法。
---

Ultracite 通过自动生成针对特定编辑器的规则文件，实现与 AI 编码助手的无缝集成。这些规则可指导 AI 编码助手编写更好、更一致并遵循最佳实践的代码。

这些编辑器规则与 Biome 的 lint 和格式化功能配合使用。Biome 负责代码格式化并捕获语法错误，而编辑器规则则从一开始就引导 AI 编码助手编写更优质的代码，从而减少后续修复的需求。

这种双管齐下的方法既保证了通过 Biome 实现的自动化代码质量，也保证了通过 AI 编码规则实现的智能代码生成。

## 设置

### 自动设置

当您运行 `npx ultracite init` 时，系统会提示您选择要启用的编辑器规则：

```bash
? Which editor rules do you want to enable (optional)?
  ◯ GitHub Copilot (VSCode)
  ◯ Cursor
  ◯ Windsurf
  # ... etcetera
```

这将在您的项目目录中创建相应的文件。

### 手动设置

如果您想手动设置，请在项目目录中创建相应的文件（例如为 Cursor 创建 `.cursor/rules`，为 Zed 创建 `.rules`）。然后，将 [此内容](https://github.com/haydenbleasel/ultracite/tree/main/.cursor/rules/ultracite.mdc) 复制并粘贴到该文件中。

## 支持的编辑器

| 编辑器           | 规则文件位置                       |
| --------------- | --------------------------------- |
| GitHub Copilot  | `.github/copilot-instructions.md` |
| Cursor          | `.cursor/rules/ultracite.mdc`     |
| Windsurf        | `.windsurf/rules/ultracite.md`    |
| Zed             | `.rules`                          |
| Claude Code     | `.claude/CLAUDE.md`               |
| OpenAI Codex    | `AGENTS.md`                       |
| Kiro IDE        | `.kiro/steering/ultracite.md`     |
| Cline           | `.clinerules`                     |
| AMP             | `AGENT.md`                        |
| Aider           | `ultracite.md`                    |
| Firebase Studio | `.idx/airules.md`                 |
| Open Hands      | `.openhands/microagents/repo.md`  |
| Gemini CLI      | `GEMINI.md`                       |
| Junie           | `.junie/guidelines.md`            |
| Augment Code    | `.augment/rules/ultracite.md`     |
| Kilo Code       | `.kilocode/rules/ultracite.md`    |
| Codename Goose  | `.goosehints`                     |
| Roo Code        | `.roo/rules/ultracite.md`         |
| Warp            | `WARP.md`                         |
| Droid           | `AGENTS.md`                       |

## 优势

使用 Ultracite 编辑器规则具有多个优势：

- **一致性**: 所有 AI 生成的代码遵循相同的规范
- **质量**: 规则强制执行最佳实践并防止常见错误
- **可访问性**: 内置的无障碍指南确保代码具有包容性
- **性能**: 规则促进高效模式并避免反模式
- **安全性**: 指南有助于防止常见的安全漏洞

## 自定义

尽管默认规则已很全面，您仍可根据特定需求进行自定义：

1. **修改现有规则**: 直接编辑规则文件
2. **添加项目特定规则**: 追加额外的指南
3. **禁用规则**: 删除或注释掉不适用于您项目的规则